Normalization View report templates contain a ReportDefinition page and a ReportSheet page, that together describe the reports you can produce. CygNet provides a sample report template file NormalizationViewTemplate.xlsx for reference. It is stored in the CygNet\Services\FMS\ReportTemplates\Samples folder on your host server.
The ReportDefinition sheet includes the following parameters to describe the type of report to build.
The ReportSheet sheet includes the following sections and corresponding tokens to describe the specific format of the report to build. Valid tokens will be replaced by the values they represent. You may also include additional information you wish to see in the report.
You can enter additional (non-token) elements such as logos, labels, or text into reports. Elements that are not valid token values will be displayed as entered.
Note: This means that tokens with typographical errors, therefore not "valid" tokens, will also be displayed as entered.
Example
Base Temperature is a valid token. If you use [BaseTemp] (not a valid token) instead of [BaseTemperature], the value will be displayed as "[BaseTemp]" instead of displaying the base temperature value desired, since [BaseTemp] is not a valid token.
|
[BaseTemp] |
The ReportDefinition uses parameters to describe the type of report for the service to build. The following parameters determine the described characteristics of your report.
Report parameters, which appear between #ReportParameters# and #End#, can be defined by the following values.
| Parameter | Description | Value |
|---|---|---|
|
ReportName |
The value defined in this cell will be used for the report name, as it will appear in drop-down menus in FMS Explorer and CygNet Explorer. See Using the Reports Control and Scheduling FMS Command Tasks in the MSS for more information. |
Enter a value to be used for the report name. Example Normalization View |
|
CommandName |
The value defined in this cell will be used by the service to determine which specific report command type to execute. See FMSClient Methods in the Scripting section for more information. |
Enter a value to specify the report command name. Example STN Note: Maximum of 7 characters; letters or numbers only, no spaces. |
Normalization View report worksheet parameters, which appear between #Worksheet# and #End#, can be defined by the following values.
| Parameter | Description | Value |
|---|---|---|
|
ReportType |
The value defined in this cell will be used to represent the standard FMS report type you are configuring. |
Enter a value to be used to indicate the type of the report. Example Normalization View |
|
The value defined in this cell will be used to specify the name of the normalization view to use for the report. |
Enter a normalization view name. Example <User Norm View> See Configuring Normalization Views for information about viewing available, or creating new, normalization views. This parameter is required. |
|
|
UpdateNorm |
The value defined in this cell will be used to specify whether or not to update the normalization view prior to running the report. |
Enter one of the following options.
Note: A security level of 2 is required to run reports, but a security level of 3 is required to update normalization views. Therefore if a user with security level 2 selects Yes for this parameter, the selection will not be recognized. A warning will be logged to the service, and the normalization view will not be updated. This parameter is required. |
|
DisplayValue |
The value defined in this cell will be used to specify the value for which to display data in your report. |
Enter one of the following options.
This parameter is required. |
|
DisplayFormat |
The value defined in this cell will be used to specify the format in which to display data in your report. |
Enter one of the following options.
This parameter is required. |
|
SummaryDataToDisplay |
If used, the value defined in this cell will be used to specify the type of summary data to display in your report. |
If used, enter one of the following options.
This parameter is optional. |
|
The value defined in this cell will be used in your report to represent the value for the Group name or Group description fields when either of the following is true.
|
Enter a value to be used to indicate the Group name or Group description when the command was not run against a single group Node. Example [Invalid Group] This parameter is optional. |
|
|
NodeNameDescFormat |
The value defined in this cell will be used in your report to represent the value for the Node name/description field. |
Enter one of the following options.
Default value is Name. |
|
NodeSortOrder |
The value defined in this cell will be used to specify the order in which to display Node results in the report. |
Enter one of the following options.
Default value is Name ascending. This parameter is optional. |
|
RptStDate |
Note: If you use this parameter in your report template, the RptStDate parameter will no longer appear for configuration in FMS Explorer or CygNet Explorer. See Normalization View Report Definitions (FMS Explorer) or Reports: Normalization View (CygNet Explorer) for more information. |
If used, enter a valid start date value for the report. RptStDate and RptEndDate must be the same configuration parameter type. Notes: The report will display data in Device time (D), although the report command parameters are configured relative to Contract time (C). The report will only include records that exist entirely within the specified date range. See Selecting Date and Time for more information. This parameter is optional. |
|
RptEndDate |
Note: If you use this parameter in your report template, the RptEndDate parameter will no longer appear for configuration in FMS Explorer or CygNet Explorer. See Normalization View Report Definitions (FMS Explorer) or Reports: Normalization View (CygNet Explorer) for more information. |
If used, enter a valid end date value for the report. RptStDate and RptEndDate must be the same configuration parameter type. Notes: The report will display data in Device time (D), although the report command parameters are configured relative to Contract time (C). The report will only include records that exist entirely within the specified date range. See Selecting Date and Time for more information. This parameter is optional. |
|
RptUnitSet |
Note: If you use this parameter in your report template, the RptUnitSet parameter will no longer appear for configuration in FMS Explorer or CygNet Explorer. See Normalization View Report Definitions (FMS Explorer) or Reports: Normalization View (CygNet Explorer) for more information. |
If used, enter a valid unit set value for the report. Valid unit set values defined in the service can be viewed through the Admin menu in FMS Explorer. See Configuring Unit Set Definitions for more information. This parameter is optional. |
The ReportSheet uses tokens to describe the format of the report you want to run. The following tokens determine the report content, and will retrieve the corresponding values for display in your report.
Note: Enter report tokens carefully, as the tokens are case sensitive. Typographical errors (therefore not "valid" tokens) will be handled as "additional values" and displayed as entered; the non-token value will appear in your report instead of the actual value(s) the correctly entered token would have retrieved. See Displaying Additional (Non-Token) Values above for more information.
Normalization View report headers, which appear above #EndReportHdr#, can be described by the following tokens.
| Token | Description |
|---|---|
| [NormalizationView] | Name of the normalization view used to generate the report |
| [CmdGroupName] | The name of the group Node against which the command was run, if applicable See also NoCmdGroupToken parameter. |
| [CmdGroupDesc] | The description of the group Node against which the command was run, if applicable See also NoCmdGroupToken parameter. |
| [GeneratedDateTime] | The time the report was generated, in Local time (L) |
| [BasePressure] | The base pressure conditions, as configured in the normalization view If base pressure is not normalized as part of the normalization view definition, this field will display "Unknown" |
| [BaseTemperature] | The base temperature conditions, as configured in the normalization view If base temperature is not normalized as part of the normalization view definition, this field will display "Unknown" |
| [DateTimeFormat] | The date/time format, as configured in the normalization view This will display one of the following:
|
| [Units] | The units of the data in the grid |
All style token cells in the template must appear in this section. Do not delete any style token cells from the report template file, or the report will fail. It is acceptable to place blank cells between token cells.
The style of the Normalization View report, which appears between #StyleTokens# and #End#, can be described by the following tokens.
Note: Two style tokens (...1 and ...2) are provided for value, sum, and average cell types so that you can alternate row colors if desired.
| Token | Description |
|---|---|
| <DummyCell> | Establishes a cell format as empty, to hold a place in the grid |
| [StationHdrAsCol] | The format for the Station column header, when the display format is Show station as column |
| [StationHdrAsRow] | The format for the Station row header, when the display format is Show station as row |
| [DateHdrAsCol] | The format for the Date column header, when the display format is Show station as row |
| [DateHdrAsRow] | The format for the Date row header, when the display format is Show station as column |
| [TotalHdrAsCol] | The format for the Total column header, when the display format is Show station as column |
| [TotalHdrAsRow] | The format for the Total row header, when the display format is Show station as row |
| [RowVal1] | The format for the value cell, for row style 1 |
| [RowVal2] | The format for the value cell, for row style 2 |
| [RowSum1] | The format for the Sum cell, for row style 1 |
| [RowSum2] | The format for the Sum cell, for row style 2 |
| [RowAvg1] | The format for the Avg cell, for row style 1 |
| [RowAvg2] | The format for the Avg cell, for row style 2 |
| [RowSumTotal] | The format for the row below the table, displaying the Sum total |
| [RowAvgTotal] | The format for the row below the table, displaying the Avg total |
|
|
|
